<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>unit_test::runner</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__beast__unit_test__results/failed.html" title="unit_test::results::failed">
<link rel="next" href="boost__beast__unit_test__runner/runner.html" title="unit_test::runner::runner">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__unit_test__results/failed.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__unit_test__runner/runner.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="beast.ref.boost__beast__unit_test__runner"></a><a class="link" href="boost__beast__unit_test__runner.html" title="unit_test::runner">unit_test::runner</a>
</h4></div></div></div>
<p>
        Unit test runner interface.
      </p>
<h5>
<a name="beast.ref.boost__beast__unit_test__runner.h0"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__runner.synopsis"></a></span><a class="link" href="boost__beast__unit_test__runner.html#beast.ref.boost__beast__unit_test__runner.synopsis">Synopsis</a>
      </h5>
<p>
        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/_experimental/unit_test/runner.hpp" target="_top">boost/beast/_experimental/unit_test/runner.hpp</a>&gt;</code>
      </p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">runner</span>
</pre>
<h5>
<a name="beast.ref.boost__beast__unit_test__runner.h1"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__runner.member_functions"></a></span><a class="link" href="boost__beast__unit_test__runner.html#beast.ref.boost__beast__unit_test__runner.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/arg.html" title="unit_test::runner::arg">arg</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Set the argument string. <br> <span class="silver">—</span><br>
                  Returns the argument string.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/operator_eq_.html" title="unit_test::runner::operator=">operator=</a></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/run.html" title="unit_test::runner::run">run</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Run the specified suite. <br> <span class="silver">—</span><br>
                  Run a sequence of suites.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/run_each.html" title="unit_test::runner::run_each">run_each</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Run all suites in a container.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/run_each_if.html" title="unit_test::runner::run_each_if">run_each_if</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Conditionally run suites in a container.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/run_if.html" title="unit_test::runner::run_if">run_if</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Conditionally run a sequence of suites.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/runner.html" title="unit_test::runner::runner">runner</a> <span class="silver">[constructor]</span></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/_dtor_runner.html" title="unit_test::runner::~runner">~runner</a> <span class="silver">[destructor]</span></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__unit_test__runner.h2"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__runner.protected_member_functions"></a></span><a class="link" href="boost__beast__unit_test__runner.html#beast.ref.boost__beast__unit_test__runner.protected_member_functions">Protected
        Member Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_case_begin.html" title="unit_test::runner::on_case_begin">on_case_begin</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called when a new case starts.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_case_end.html" title="unit_test::runner::on_case_end">on_case_end</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called when a new case ends.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_fail.html" title="unit_test::runner::on_fail">on_fail</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called for each failing condition.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_log.html" title="unit_test::runner::on_log">on_log</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called when a test logs output.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_pass.html" title="unit_test::runner::on_pass">on_pass</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called for each passing condition.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_suite_begin.html" title="unit_test::runner::on_suite_begin">on_suite_begin</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called when a new suite starts.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__runner/on_suite_end.html" title="unit_test::runner::on_suite_end">on_suite_end</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Called when a suite ends.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__unit_test__runner.h3"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__runner.description"></a></span><a class="link" href="boost__beast__unit_test__runner.html#beast.ref.boost__beast__unit_test__runner.description">Description</a>
      </h5>
<p>
        Derived classes can customize the reporting behavior. This interface is injected
        into the <a class="link" href="../../"><code class="computeroutput"><span class="identifier">unit_test</span></code></a> class to receive the results
        of the tests.
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__unit_test__results/failed.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__unit_test__runner/runner.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
